Send-GSChatMessage¶
SYNOPSIS¶
Sends a Chat message
SYNTAX¶
Webhook (Default)¶
Send-GSChatMessage [[-Text] <String[]>] [-Thread <String>] [-FallbackText <String[]>] [-PreviewText <String>] [-ActionResponseType <String>] [-ActionResponseUrl <String>] -Webhook <String[]> [-MessageSegment <Object[]>] [<CommonParameters>]
SDK¶
Send-GSChatMessage [[-Text] <String[]>] [-Thread <String>] [-FallbackText <String[]>] [-PreviewText <String>] [-ActionResponseType <String>] [-ActionResponseUrl <String>] -Parent <String[]> [-ThreadKey <String>] [-MessageSegment <Object[]>] [<CommonParameters>]
Rest¶
Send-GSChatMessage [[-Text] <String[]>] [-Thread <String>] [-FallbackText <String[]>] [-PreviewText <String>] [-ActionResponseType <String>] [-ActionResponseUrl <String>] [-ThreadKey <String>] -RestParent <String[]> [-MessageSegment <Object[]>] [<CommonParameters>]
BodyPassThru¶
Send-GSChatMessage [[-Text] <String[]>] [-Thread <String>] [-FallbackText <String[]>] [-PreviewText <String>] [-ActionResponseType <String>] [-ActionResponseUrl <String>] [-MessageSegment <Object[]>] [-BodyPassThru] [<CommonParameters>]
DESCRIPTION¶
Sends a Chat message
EXAMPLES¶
EXAMPLE 1¶
Send-GSChatMessage -Text "Post job report:" -Cards $cards -Webhook (Get-GSChatWebhook JobReports)
Sends a simple Chat message using the JobReports webhook
EXAMPLE 2¶
NEED</b> to <i>stop</i> spending money on <b>crap</b>!" |
Add-GSChatKeyValue -TopLabel "Chocolate Budget" -Content '$5.00' -Icon DOLLAR | Add-GSChatKeyValue -TopLabel "Actual Spending" -Content '$5,000,000!' -BottomLabel "WTF" -Icon AIRPLANE | Add-GSChatImage -ImageUrl "https://media.tenor.com/images/f78545a9b520ecf953578b4be220f26d/tenor.gif" -LinkImage | Add-GSChatCardSection -SectionHeader "Dollar bills, y'all" -OutVariable sect1 | Add-GSChatButton -Text "Launch nuke" -OnClick (Add-GSChatOnClick -Url "https://github.com/scrthq/PSGSuite") -Verbose -OutVariable button1 | Add-GSChatButton -Text "Unleash hounds" -OnClick (Add-GSChatOnClick -Url "https://admin.google.com/?hl=en&authuser=0") -Verbose -OutVariable button2 | Add-GSChatCardSection -SectionHeader "What should we do?" -OutVariable sect2 | Add-GSChatCard -HeaderTitle "Makin' moves with" -HeaderSubtitle "DEM GOODIES" -OutVariable card | Add-GSChatTextParagraph -Text "This message sent by \<b>PSGSuite\</b> via WebHook!" | Add-GSChatCardSection -SectionHeader "Additional Info" -OutVariable sect2 | Send-GSChatMessage -Text "Got that report, boss:" -FallbackText "Mistakes have been made..." -Webhook ReportRoom
This example shows the pipeline capabilities of the Chat functions in PSGSuite. Starting from top to bottom: 1. Add a TextParagraph widget 2. Add a KeyValue with an icon 3. Add another KeyValue with a different icon 4. Add an image and create an OnClick event to open the image's URL by using the -LinkImage parameter 5. Add a new section to encapsulate the widgets sent through the pipeline before it 6. Add a TextButton that opens the PSGSuite GitHub repo when clicked 7. Add another TextButton that opens Google Admin Console when clicked 8. Wrap the 2 buttons in a new Section to divide the content 9. Wrap all widgets and sections in the pipeline so far in a Card 10. Add a new TextParagraph as a footer to the message 11. Wrap that TextParagraph in a new section 12. Send the message and include FallbackText that's displayed in the mobile notification. Since the final TextParagraph and Section are not followed by a new Card addition, Send-GSChatMessage will create a new Card just for the remaining segments then send the completed message via Webhook. The Webhook short-name is used to reference the full URL stored in the encrypted Config so it's not displayed in the actual script.
EXAMPLE 3¶
Get-Service | Select-Object -First 5 | ForEach-Object {
Add-GSChatKeyValue -TopLabel $.DisplayName -Content $.Status -BottomLabel $_.Name -Icon TICKET } | Add-GSChatCardSection -SectionHeader "Top 5 Services" | Send-GSChatMessage -Text "Service Report:" -FallbackText "Service Report" -Webhook Reports
This gets the first 5 Services returned by Get-Service, creates KeyValue widgets for each, wraps it in a section with a header, then sends it to the Reports Webhook
PARAMETERS¶
-ActionResponseType¶
Part of the ActionResponse. Parameters that a bot can use to configure how its response is posted.
The ActionResponseType is the type of bot response.
Available values are: * NEW_MESSAGE: Post as a new message in the topic. * UPDATE_MESSAGE: Update the bot's own message. (Only after CARD_CLICKED events.) * REQUEST_CONFIG: Privately ask the user for additional auth or config.
Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-ActionResponseUrl¶
Part of the ActionResponse. Parameters that a bot can use to configure how its response is posted.
The ActionResponseUrl is the URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-BodyPassThru¶
If $true, returns the message body.
Type: SwitchParameter Parameter Sets: BodyPassThru Aliases: Required: True Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False
-FallbackText¶
A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications).
Type: String[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-MessageSegment¶
Any Chat message segment objects created with functions named `Add-GSChat*` passed through the pipeline or added directly to this parameter as values.
If section widgets are passed directly to this function, a new section without a SectionHeader will be created and the widgets will be added to it
Type: Object[] Parameter Sets: (All) Aliases: InputObject Required: False Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False
-Parent¶
The resource name of the space to send the message to, in the form "spaces".
Example: spaces/AAAAMpdlehY
Type: String[] Parameter Sets: SDK Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-PreviewText¶
Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips.
Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-RestParent¶
The resource name of the space to send the message to via REST API call, in the form "spaces".
Example: spaces/AAAAMpdlehY
Type: String[] Parameter Sets: Rest Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-Text¶
Plain-text body of the message.
Type: String[] Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False
-Thread¶
The thread the message belongs to, in the form "spaces/threads".
Example: spaces/AAAA3dnRkmI/threads/_EyIp5BthJk
Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-ThreadKey¶
Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it.
Type: String Parameter Sets: SDK, Rest Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-Webhook¶
The Url of the Webhook for the space to send the message to.
You can safely store an encrypted dictionary of Webhooks in the PSGSuite Config by passing a hashtable to the `-Webhook` parameter, i.e.: Set-PSGSuiteConfig -Webhook @{JobReports = 'https://chat.googleapis.com/v1/spaces/xxxxxxxxxx/messages?key=xxxxxxxxxxxxxxxxxx&token=xxxxxxxxxxxxxxxxxx'}
To retrieve a stored Webhook, you can use `Get-GSChatWebhook`, i.e.: Send-GSChatMessage -Text "Post job report:" -Cards $cards -Webhook (Get-GSChatWebhook JobReports)
Type: String[] Parameter Sets: Webhook Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.